DOC: Fix flake8 issues with whatsnew v0.18.* #24303

JimJeon · 2018-12-16T08:31:02Z

Fixed almost every flake8 issues in v0.18.*.rst except one issue
about tab-completion.

closes DOC: Fix flake8 issues in doc/source/whatsnew/v0.18.*.rst #24233
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

I fixed almost every flake8 issues except one.
An issue about tab-completion and I have no idea how to fix it.

In doc/source/whatsnew/v0.18.0.rst there is a code like below.

In [9]: r.<TAB>
r.A           r.agg         r.apply       r.count       r.exclusions  r.max         r.median      r.name        r.skew        r.sum
r.B           r.aggregate   r.corr        r.cov         r.kurt        r.mean        r.min         r.quantile    r.std         r.var

I've searched with grep in every whatsnew files but there was only one other example about this in v0.17.0.rst. Would you review this PR?

Fixed almost every flake8 issues in v0.18.*.rst except one issue about tab-completion.

From conversations in pandas-dev#24273, I found that everywhere in pandas documentation should use `io` and not `compat`.

saurav2608 · 2018-12-16T09:02:18Z

thanks @JimJeon : Please wait for a formal review from the maintainers. I just want to point that you have to remove the block between 8 & 11 for both the files (the below chunk should be deleted). Removal should generate some more errors.

.. ipython:: python
   :suppress:

   from pandas import * # noqa F401, F403

datapythonista · 2018-12-16T10:03:43Z

also, for the tab error, we use a noqa, do a grep "<TAB>" *.rst to see other cases

codecov · 2018-12-16T12:14:54Z

Codecov Report

Merging #24303 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #24303   +/-   ##
=======================================
  Coverage   92.28%   92.28%           
=======================================
  Files         162      162           
  Lines       51827    51827           
=======================================
  Hits        47827    47827           
  Misses       4000     4000

Flag	Coverage Δ
#multiple	`90.68% <ø> (ø)`	⬆️
#single	`43.01% <ø> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 41681c8...7e4bc37. Read the comment docs.

codecov · 2018-12-16T12:14:55Z

Codecov Report

Merging #24303 into master will increase coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #24303      +/-   ##
==========================================
+ Coverage   92.28%   92.28%   +<.01%     
==========================================
  Files         162      162              
  Lines       51827    51831       +4     
==========================================
+ Hits        47827    47831       +4     
  Misses       4000     4000

Flag	Coverage Δ
#multiple	`90.68% <ø> (-0.01%)`	⬇️
#single	`43% <ø> (-0.02%)`	⬇️

Impacted Files	Coverage Δ
pandas/util/_test_decorators.py	`90.54% <0%> (-2.71%)`	⬇️
pandas/core/indexes/period.py	`93.06% <0%> (ø)`	⬆️
pandas/core/indexes/accessors.py	`91.08% <0%> (ø)`	⬆️
pandas/core/arrays/datetimelike.py	`96.44% <0%> (ø)`	⬆️
pandas/core/arrays/period.py	`98.5% <0%> (+0.01%)`	⬆️
pandas/util/testing.py	`87.58% <0%> (+0.09%)`	⬆️
pandas/plotting/_converter.py	`63.82% <0%> (+0.14%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 41681c8...a17fa1b. Read the comment docs.

datapythonista

Looks good, added some comments, also what @saurav2608 said and the tab.

datapythonista · 2018-12-17T00:38:25Z

doc/source/whatsnew/v0.18.1.rst

@@ -53,6 +53,7 @@ Friday before MLK Day

 .. ipython:: python

+    from datetime import datetime


can you use import datetime instead, and use datetime.datetime(...) below

Sure. May I ask why you prefer that?
Is that because it can cause some namespace issues?

There are many reasons, and some are not trivial to explain.

The main one is that if I see a bare datetime in Python code, I need to guess whether it's the main module, or the datetime.datetime module. While there is no ambiguity in reading datetime.datetime.

Then, with a from datetime import datetime I load the whole datetime module in sys.modules, but I only have access in the namespace to the datetime.datetime submodule (with the name datetime). This won't let me perform operations like imp.reload(datetime), as I don't have anything in the namespace pointing to the main datetime module.

datapythonista · 2018-12-17T00:40:12Z

doc/source/whatsnew/v0.18.1.rst

-                                                                       freq='12H'),
-                                                        ['a', 'b']]))
+                       index=pd.MultiIndex.
+                       from_product([pd.date_range('20130101',


I found this indentation confusing. If the lines are too long, can we use something like:

dft2 = pd.DataFrame( np.random.randn(20, 1), ...

Thanks for the comment. I wasn't flexible with that. I'll fix it.

datapythonista · 2018-12-17T00:40:43Z

doc/source/whatsnew/v0.18.1.rst

@@ -451,15 +454,17 @@ New Behavior:
 .. code-block:: python


Suggested change

.. code-block:: python

.. code-block:: ipython

datapythonista · 2018-12-17T00:41:35Z

doc/source/whatsnew/v0.18.1.rst

+.. ipython:: python
+   :suppress:
+
+   from io import StringIO


can you use import io instead, and have the import visible in the next block, where it's used.

Sure. I'll fix it.

JimJeon · 2018-12-17T01:32:27Z

@saurav2608 @datapythonista Thanks for the reviews!

datapythonista · 2018-12-17T01:34:33Z

doc/source/whatsnew/v0.18.1.rst

+.. ipython:: python
+   :suppress:
+
+   import io


can you move the import to the beginning of the next code block, and remove this block.

jreback · 2018-12-17T12:41:44Z

doc/source/whatsnew/v0.18.1.rst

 In order to standardize the ``read_csv`` API for both the ``c`` and ``python`` engines, both will now raise an
 ``EmptyDataError``, a subclass of ``ValueError``, in response to empty columns or header (:issue:`12493`, :issue:`12506`)

 Previous behaviour:

 .. code-block:: ipython
+   In [1]: import io


I think you need a blank line here

jreback · 2018-12-17T12:42:02Z

some comments. ping on green.

datapythonista

lgtm, thanks @JimJeon

jreback · 2018-12-18T12:39:51Z

thanks

JimJeon added 2 commits December 16, 2018 17:02

DOC: Fix flake8 issues with whatsnew v0.18.*

67ff7ae

Fixed almost every flake8 issues in v0.18.*.rst except one issue about tab-completion.

DOC: Fixes import of StringIO

7e4bc37

From conversations in pandas-dev#24273, I found that everywhere in pandas documentation should use `io` and not `compat`.

datapythonista added Docs Clean labels Dec 17, 2018

datapythonista reviewed Dec 17, 2018

View reviewed changes

JimJeon added 2 commits December 17, 2018 10:28

DOC: Fix reviewed issues

f898da7

DOC: Remove pandas import from v0.18.1

2d7d5e5

datapythonista reviewed Dec 17, 2018

View reviewed changes

DOC: Rearrange the import block

c3fd30f

jreback added this to the 0.24.0 milestone Dec 17, 2018

jreback reviewed Dec 17, 2018

View reviewed changes

DOC: Add a blank line

a17fa1b

datapythonista approved these changes Dec 18, 2018

View reviewed changes

jreback merged commit 6c67c78 into pandas-dev:master Dec 18, 2018

TomAugspurger pushed a commit to TomAugspurger/pandas that referenced this pull request Dec 20, 2018

DOC: Fix flake8 issues with whatsnew v0.18.* (pandas-dev#24303)

7d1c022

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

DOC: Fix flake8 issues with whatsnew v0.18.* (pandas-dev#24303)

42cf721

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

DOC: Fix flake8 issues with whatsnew v0.18.* (pandas-dev#24303)

1d9fac5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Fix flake8 issues with whatsnew v0.18.* #24303

DOC: Fix flake8 issues with whatsnew v0.18.* #24303

JimJeon commented Dec 16, 2018

saurav2608 commented Dec 16, 2018

datapythonista commented Dec 16, 2018

codecov bot commented Dec 16, 2018

codecov bot commented Dec 16, 2018 •

edited

Loading

datapythonista left a comment

datapythonista Dec 17, 2018

JimJeon Dec 17, 2018

datapythonista Dec 17, 2018

datapythonista Dec 17, 2018

JimJeon Dec 17, 2018

datapythonista Dec 17, 2018

datapythonista Dec 17, 2018

JimJeon Dec 17, 2018

JimJeon commented Dec 17, 2018

datapythonista Dec 17, 2018

JimJeon Dec 17, 2018

jreback Dec 17, 2018

JimJeon Dec 18, 2018

jreback commented Dec 17, 2018

datapythonista left a comment

jreback commented Dec 18, 2018

		@@ -53,6 +53,7 @@ Friday before MLK Day

		.. ipython:: python

		from datetime import datetime

DOC: Fix flake8 issues with whatsnew v0.18.* #24303

DOC: Fix flake8 issues with whatsnew v0.18.* #24303

Conversation

JimJeon commented Dec 16, 2018

saurav2608 commented Dec 16, 2018

datapythonista commented Dec 16, 2018

codecov bot commented Dec 16, 2018

Codecov Report

codecov bot commented Dec 16, 2018 • edited Loading

Codecov Report

datapythonista left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JimJeon commented Dec 17, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Dec 17, 2018

datapythonista left a comment

Choose a reason for hiding this comment

jreback commented Dec 18, 2018

codecov bot commented Dec 16, 2018 •

edited

Loading